[Feature] add deactivate devices guide #252
Conversation
|
CLA Assistant Lite bot All contributors have signed the CLA ✍️ |
|
Thanks! You do not need to include a changelog update for documentation changes, that's just for things that affect usage / functionality. I'm adding @annie-payseur to the review to give feedback on the docs. |
docs/userguides/deactivatedevices.md
Outdated
| @@ -0,0 +1,65 @@ | |||
| # Clean up your environment by deactivating devices | |||
|
|
|||
| Your Code42 environment may contain many old devices that are no longer active computers, and that have not connected to Code42 in quite some time. In order to clean up your environment, you can use the CLI to deactivate these devices in bulk. | |||
There was a problem hiding this comment.
Lines are bit long - obviously only appears so in editors, but it doesn't hurt to put newlines in.
There was a problem hiding this comment.
I've added some line breaks. It's pretty arbitrary at this point so we may want to move them around later.
docs/userguides/deactivatedevices.md
Outdated
|
|
||
| The `code42 devices bulk deactivate` command will output the input | ||
| you gave it, plus a column indicating the success or failure of | ||
| the deactivation. To change the format of this output, use the |
There was a problem hiding this comment.
This "...will output the input you gave it" seems confusing. That statement also seems to suggest you can use code42 devices bulk deactivate standalone, which you can't.
There was a problem hiding this comment.
I've rephrased this. The code42 devices bulk deactivate command can be used standalone, but it does need to be provided an input spreadsheet. The output is the guid plus an indication of whether or not the deactivation was successful, which hopefully the new wording communicates better.
Description of Change
This adds a user guide to clarify how to use the
code42 devices listandcode42 devices bulk deactivatecommands in combination. We've had several internal questions about how to do this and what the capabilities are over the past few days, so I wanted to get something added to the documentation.I've added the guide, but I'm not sure if there needs to be a changelog update for documentation changes. Should I put a line there?
Please also feel free to make any edits or changes you feel are necessary or recommended to the guide, it's very much a first draft at the moment.